feat: add interactive tutorial onboarding flow#605
feat: add interactive tutorial onboarding flow#605Mailos07 wants to merge 5 commits intoscribe-org:mainfrom
Conversation
Thank you for the pull request! 💙🩵The Scribe-Android team will do our best to address your contribution as soon as we can. The following are some important points:
Note Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible. |
Maintainer ChecklistThe following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
First PR Commit Check
- The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution
- The contributor's name and icon in remote commits should be the same as what appears in the PR
- If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for
git config user.emailin their local Scribe-Android repo (can be set withgit config --global user.email "GITHUB_EMAIL")
|
Hey @Mailos07 👋 Thanks so much for the PR :) Looks like we have failing tests, and on an emulator (Pixel 9 API 36) clicking the "Quick tutorial" button on the first screen doesn't work. Could you take a look at this, and maybe also share some screenshots of what you're seeing? We also want a "Quick tutorial" option within the About screen as seen here. And the screenshot for that page is: https://www.figma.com/design/c8945w2iyoPYVhsqW7vRn6/scribe_public_designs?node-id=4277-4424&t=7PMENNPkEkneTpEE-1. |
2 participants
Contributor checklist
./gradlew lintKotlin detekt testcommand as directed in the testing section of the contributing guideDescription
Adds an interactive tutorial onboarding flow accessible from the About tab, based on the Figma designs for the tutorial screens. The tutorial guides new users through Scribe's core features with hands-on practice rather than passive video.
Discussed and approved by @andrewtavis on Matrix prior to implementation.
Changes
TutorialHomeScreen— landing page with chapter list and "Start full tutorial" buttonTutorialStepScreen— reusable interactive lesson component with input validation and Scribe keyboard detectionTutorialNavigator— navigation controller managing flow between chapters and stepsWrongKeyboardScreen— guides users to switch to a Scribe keyboard when a non-Scribe keyboard is active, with a focused input field that triggers the system keyboard for easy switchingAboutScreen— adds a "Start full tutorial" button to launch the tutorial flowTutorial chapters
Notes
Related
References discussion on Matrix where this in-app guided onboarding tutorial was discussed and approved by @andrewtavis prior to implementation.
Related issue